DSV API POE
Request Attributes
Y – Required (Must be set in the input)
O – Optional (May be sent in addition to required fields).
/getStatus
Request Parameters
Method: POST
Content-Type: application/json
Body :
| Object | Child Object | Attribute | Type | Required | Possible Values | Description |
|---|---|---|---|---|---|---|
| pageSet | startIndex | Number | O | Default 1 | This attribute enables the pagination. Helps to fetch the records starting with specific Index value | |
| pageSet | recordSize | Number | O | Default 500 | Controls the number of records to be retrieved per page. Max allowed value is 500 per request | |
| bookingsRequest | sourceXmlBookingId | String | Y | Distributor Xml Reference ID | ||
| bookingsRequest | sourceProfileId | Number | O | Unique distributor source profile id generated at WIPS | ||
| bookingsRequest | ciscoCreated | String | O | Y/N | Filter to control whether cisco created internal bookings to be included in API response or not. Default Values is N | |
| bookingsRequest | bookingsSearchCriteria | distiSONumber | String | Y | Supports Multiple values in one request and the data has to be in different array | |
| bookingsRequest | bookingsSearchCriteria | distiSOLineNumber | String | O | Supports Multiple values in one request and the data has to be in different array | |
| bookingsRequest | bookingsSearchCriteria | resellerPONumber | String | O | Supports Multiple values in one request and the data has to be in different array | |
| bookingsRequest | bookingsSearchCriteria | dealID | String | O | Supports Multiple values in one request and the data has to be in different array | |
| bookingsRequest | bookingsSearchCriteria | serviceQuote | String | O | Supports Multiple values in one request and the data has to be in different array |
/getDetails
Request Parameters
Method: POST
Content-Type: application/json
Body :
| Object | Attribute | Type | Required | Possible Values | Description |
|---|---|---|---|---|---|
| pageSet | startIndex | Number | O | Default 1 | This attribute enables the pagination. Helps to fetch the records starting with specific Index value |
| pageSet | recordSize | Number | O | Default 500 | Controls the number of records to be retrieved per page. Max allowed value is 500 per request |
| bookingsDetailRequest | sourceXmlBookingId | String | Y | Distributor Xml Reference ID | |
| bookingsDetailRequest | sourceProfileId | Number | O | Unique distributor source profile id generated at WIPS | |
| bookingsDetailRequest | ciscoCreated | String | O | Y/N | Filter to control whether cisco created internal bookings to be included in API response or not. Default Values is N |
| bookingsDetailRequest | distiSONumber | String | Y | Supports only one value in a request call | |
| bookingsDetailRequest | ciscoStandardPartNumber | String | O | Supports only one value in a request call | |
| bookingsDetailRequest | dealID | String | O | Supports Multiple values in one request and the data has to be in different array |
/searchDSV
Request Parameters
Method: POST
Content-Type: application/json
Body :
| Object | Attribute | Type | Required | Possible Values | Description |
|---|---|---|---|---|---|
| pageSet | startIndex | Number | O | Default 1 | This attribute enables the pagination. Helps to fetch the records starting with specific Index value |
| pageSet | recordSize | Number | O | Max 500 | Controls the number of records to be retrieved per page. Max allowed value is 500 per request |
| bookingsRequest | sourceXmlBookingId OR sourceProfileId | sourceXmlBookingId (String) sourceProfileId (Number) | Y | Unique distributor source profile id generated at WIPS | |
| bookingsRequest | batchId | Number | O | Supports only one value in a request call | |
| bookingsRequest | submissionId | Number | O | Supports only one value in a request call | |
| bookingsRequest | distiSONumber | String | O | ["123","124","125"] | Supports max of 5 items with comma seaprated in the array |
| bookingsRequest | distiSOLineNumber | String | O | Supports only one value in a request call | |
| bookingsRequest | submissionFrom | String | O | Supports only one value in a request call, SubmissionFrom and submissionTo should not be > 90 days | |
| bookingsRequest | submissionTo | String | O | Supports only one value in a request call | |
| bookingsRequest | postedFrom | String | O | Supports only one value in a request call, postedFrom and postedTo should not be > 90 days | |
| bookingsRequest | postedTo | String | O | Supports only one value in a request call | |
| bookingsRequest | dealID | String | O | Supports only one value in a request call | |
| bookingsRequest | ciscoCreated | String | O | Y or N | Filter to control whether cisco created internal bookings to be included in API response or not. Default fetches both Y and N flag |
| bookingsRequest | magicKey | String | O | Supports only one value in a request call. Supports prefix based search as well | |
| bookingsRequest | distiPoToCisco | String | O | Supports only one value in a request call | |
| bookingsRequest | resellerCountry | String | O | Supports only one value in a request call. submissionFrom and submissionTo should be provided | |
| bookingsRequest | status | String | O | Eg: "INVALID", "POSTED", "CANCELLED","CLOSED" | Supports only one value in a request call |
| bookingsRequest | dsvUniqueId | Number | O | Supports only one value in a request call | |
| bookingsRequest | reportedDealId | String | O | Supports only one value in a request call | |
| bookingsRequest | promoNumber | String | O | Supports only one value in a request call | |
| bookingsRequest | serviceQuote | String | O | Supports only one value in a request call | |
| bookingsRequest | resellerPONumber | String | O | Supports only one value in a request call | |
| bookingsRequest | ciscoStandardPartNumber | String | O | Supports only one value in a request call |